home *** CD-ROM | disk | FTP | other *** search
/ Teach Yourself VRML 2 in 21 Days / Teach Yourself VRML 2 in 21 Days.iso / mac / ISO9660 / 3rdparty / POLYTRAN / dos / PT_DOS.ZIP / DOC_MAN / IMP_STRA.MAN < prev    next >
Encoding:
Text File  |  1996-08-24  |  11.4 KB  |  326 lines
  1.  
  2.  
  3. Import-StudioPro()         Unix Programmer's Manual         Import-StudioPro()
  4.  
  5.  
  6. NAME
  7.      imp_stra - Strata StudioPro geometry import filter
  8.  
  9. SYNOPSIS
  10.  
  11.      This man page describes the options  specific  to  the  Strata  StudioPro
  12.      geometry import converter.
  13.  
  14. EXAMPLE CONVERSION SYNTAX
  15.  
  16.      To convert a  Strata  StudioPro  file  to  Wavefront  using  the  default
  17.      parameters listed in the setup.ini file:
  18.  
  19.           pt -i sspro -o wave filename.vis
  20.  
  21.      To convert a Strata StudioPro file to  VRML  and  override  some  of  the
  22.      default options in setup.ini:
  23.  
  24.           pt -i sspro -in-sspro-debug = yes -o vrml filename.vis
  25.  
  26. OVERVIEW
  27.  
  28.      This geometry import converter  reads  files  which  are  in  the  Strata
  29.      StudioPro  file  format.  This  converter  is  probably  one  of the most
  30.      complete Strata StudioPro file readers next to that of the  one  included
  31.      with  Strata  StudioPro  itself. You will find that most StudioPro models
  32.      are of quite high quality, with good use  of  bezier  patches  (for  high
  33.      resolution  modeling)  and  good use of shading + texture mapping to give
  34.      realistic rendered results.
  35.  
  36.      This converter reads in almost every aspect of a StudioPro file  so  that
  37.      the  file  can  be rendered with little or no modifications by the NuGraf
  38.      renderer, or exported and rendered faithfully with an  external  renderer
  39.      such  as Autodesk's 3D Studio. All in all this is one of the more complex
  40.      import converters. See the end of the this  file  which  describes  which
  41.      entities are handled by this converter.
  42.  
  43. OVERVIEW
  44.  
  45.      1. If you are converting a Strata StudioPro file which was obtained  from
  46.      an  Apple  Macintosh  machine  then you must manually add the '.vis' file
  47.      extension to these files.
  48.  
  49.      2. There is a good chance that this converter will  not  work  on  future
  50.      files saved from Strata's StudioPro program. This is due to the fact that
  51.      the StudioPro file format does not allow unknown  chunks  to  be  skipped
  52.      over.  At such a time this converter will be updated with the file format
  53.      information must be officially obtained from Strata Corporation.
  54.  
  55.      3. Strata StudioPro files are unusual  because  they  embed  the  texture
  56.      images  right inside the scene file itself (almost all other file formats
  57.      do not do this). This converter extracts these embedded images and stores
  58.      them  on  disk  as  TIFF  files with the first few letters of the texture
  59.      image filename coming from that of the original StudioPro input filename.
  60.      The  TIFF files are stored in the directory controlled by the '-in-sspro-
  61.      texture-dest-directory-type' option described below.
  62.  
  63.  
  64.                                                                              1
  65.  
  66.  
  67.  
  68. Import-StudioPro()         Unix Programmer's Manual         Import-StudioPro()
  69.  
  70.  
  71.      4. Please be wary of any StudioPro files which were not  written  out  by
  72.      the  Strata  StudioPro program itself - many of such files are corrupt or
  73.      written in a non-standard method. For example,  the  StudioPro  files  on
  74.      Viewpoint  Datalab's  '5  Free  for Siggraph 95' are some such examples -
  75.      they have placed each and every polygon within its own object  definition
  76.      rather  than placing all polygons within one object; in addition, many of
  77.      these example models have incorrect entity offsets  that  are  completely
  78.      illegal.  This  converter  tries to detect such bad files and will try to
  79.      read the files if possible.
  80.  
  81. COMMAND LINE OPTIONS
  82.  
  83.      The following options are specific to this import converter:
  84.  
  85.      -i sspro
  86.           This is the optional command line option which  specifies  that  the
  87.           input data is in Strata StudioPro file format. If not specified then
  88.           the converter will try to guess the input  file's  format  from  its
  89.           file extension and then from the contents of its file. Note that the
  90.           valid file extension is .vis.
  91.  
  92.      -in-sspro-bezier-subdiv-type = [ low | medium | high | custom ]
  93.           Many StudioPro models are created using Bezier patches  rather  than
  94.           polygons. Bezier patches are stored in the file using a mathematical
  95.           description of a smooth surface instead of a rough approximation  by
  96.           polygons.
  97.  
  98.           During the export process (say,  when  exporting  a  StudioPro  file
  99.           format  to  3D  Studio),  these  Bezier patches must be converted to
  100.           polygons. The '-in-sspro-bezier-subdiv-type'  option  specifies  how
  101.           finely  to  subdivide  these  bezier  patches when turning them into
  102.           polygonalized surfaces. Higher numbers created  more  polygons,  and
  103.           thus  smoother surfaces, but at the expense of larger exported files
  104.           and longer rendering times.
  105.  
  106.           The program defaults to 'low' (6x6  subdivisions).  A  good  way  of
  107.           determining  if you need to increase this subdivision level is check
  108.           to see if the exported  file  is  being  rendered  properly  in  the
  109.           destination  renderer.  In  many  cases StudioPro bezier patches are
  110.           highly curved which causes 'non-planar' polygons to  appear  in  the
  111.           exported  file;  these  non-planar  polygons  are  illegal  in  many
  112.           rendering programs. To solve this non-planar polygon  problem,  just
  113.           increase  the  number  of  subdivisions  (so  that  the bezier patch
  114.           surface is turned into many more smaller polygons).
  115.  
  116.           The following describe the different subdivision levels:
  117.  
  118.           low = 6x6 = 36 polygons per Bezier patch.
  119.  
  120.           medium = 20x20 = 400 polygons per Bezier patch.
  121.  
  122.           high = 50x50 = 2500 polygons per Bezier patch.
  123.  
  124.           custom = User defined. The subdivision level is set with  the  '-in-
  125.           sspro-bezier-subdivisions' described below.
  126.  
  127.  
  128.  
  129.                                                                              2
  130.  
  131.  
  132.  
  133. Import-StudioPro()         Unix Programmer's Manual         Import-StudioPro()
  134.  
  135.  
  136.      -in-sspro-bezier-subdivisions = <num_bezier_subdivisions>
  137.           This is the number of subdivisions in the u  and  v  directions  for
  138.           Bezier patches if the '-in-sspro-bezier-subdiv-type' option above is
  139.           set to 'custom'. If you assign a number  greater  than  1  then  the
  140.           bezier  patch will be subdivided into the square of this number. For
  141.           example, if you assign 4 then 16  polygons  will  be  used.  If  you
  142.           assign 10 then 100 polygons will be used.
  143.  
  144.      -in-sspro-confirm-txtr-overwrites = [ yes | no ]
  145.           Strata StudioPro files are unusual because they  embed  the  texture
  146.           images  right  inside  the  scene file itself (almost all other file
  147.           formats do not do this).  This  converter  extracts  these  embedded
  148.           images  and  stores  them  on  disk  as  TIFF files in the directory
  149.           controlled  by  the  '-in-sspro-texture-dest-directory-type'  option
  150.           described below.
  151.  
  152.           If this option is set to 'yes' then the program will  first  confirm
  153.           whether  a texture file (which is being extracted from the StudioPro
  154.           file and saved to disk) should be overwritten. If the user does  not
  155.           want  the file, which already exists on disk, to be overwritten then
  156.           the converter will skip it. If this checkbox is not enabled then any
  157.           potential file overwrites will not be confirmed.
  158.  
  159.      -in-sspro-texture-dest-directory-type = [ use-input-file-directory | use-
  160.           execution-directory | use-specific-directory ]
  161.           Strata StudioPro files are unusual because they  embed  the  texture
  162.           images  right  inside the scene file itself. This converter extracts
  163.           these embedded images and stores them on disk as TIFF files  in  the
  164.           directory controlled by this '-in-sspro-texture-dest-directory-type'
  165.           option.
  166.  
  167.           The 'use-input-file-directory' option saves out the TIFF  images  to
  168.           the  same  directory  where the Strata StudioPro input file was read
  169.           from.
  170.  
  171.           The 'use-execution-directory' option saves out the  TIFF  images  to
  172.           the directory where this translation program was executed from.
  173.  
  174.           The 'use-specific-directory' option saves out the TIFF images to the
  175.           directory specified by the '-in-sspro-texture-dest-directory' option
  176.           below.
  177.  
  178.      -in-sspro-texture-dest-directory = "a valid directory path"
  179.           This option lists  a  directory  path  where  the  Strata  StudioPro
  180.           embedded  bitmap  images  will be saved to disk as TIFF images. This
  181.           directory  path  only  applies  while  the  '-in-sspro-texture-dest-
  182.           directory-type' option is set to 'use-specific-directory'.
  183.  
  184.      -in-sspro-output-debug-info = [ yes | no ]
  185.           If this option is set to 'yes'  then  the  contents  of  the  Strata
  186.           StudioPro  file  will  be verbosely described and output to the file
  187.           'debugstr.txt'.
  188.  
  189.      -in-sspro-report-stats = [ yes | no ]
  190.           If this option is set to 'yes' then the converter  will  report  the
  191.           number of objects, polygons, cameras, lights and materials created.
  192.  
  193.  
  194.                                                                              3
  195.  
  196.  
  197.  
  198. Import-StudioPro()         Unix Programmer's Manual         Import-StudioPro()
  199.  
  200.  
  201.      -in-sspro-read-cameras = [ yes | no ]
  202.      -in-sspro-read-lights = [ yes | no ]
  203.      -in-sspro-read-geometry = [ yes | no ]
  204.      -in-sspro-read-materials = [ yes | no ]
  205.           These switches allow specific sections of the Strata StudioPro  file
  206.           to  be  excluded  or  included in the import process. All default to
  207.           'yes' which means that all named entities will be read in. If set to
  208.           'no' then the named section(s) will not be read into memory.
  209.  
  210. CURRENTLY SUPPORTED STUDIOPRO ENTITIES
  211.  
  212.      TCONE
  213.      TCUBE
  214.      TBEZIERMESH
  215.      TBEZIERPATCH
  216.      TDISC
  217.      TENTITY
  218.      TINSTANCE
  219.      TGROUP
  220.      TCAMERA
  221.      TMODEL
  222.      TMESH
  223.      TDIRECTIONALLIGHT
  224.      TPOSITIONALLIGHT
  225.      TBULEMICMESH
  226.      TSELECTIVEMESH
  227.      TORDEREDBEZIERMESH
  228.      TSPHERE
  229.      TSPOTLIGHT
  230.      TIMAGEMAP
  231.      TRGBIMAGEMAP
  232.      T2DRECT
  233.      TATTRIBUTE
  234.      T2DPOLYLINE
  235.      T2DHOLE
  236.      T2DPOLYGON
  237.      TSHADER
  238.      TMETALSHADER
  239.      TPOLYLINE
  240.      THOLE
  241.      TPOLYGON
  242.      TSURFACEMAP
  243.  
  244. CURRENTLY NON-SUPPORTED STUDIOPRO ENTITIES
  245.  
  246.      T3DPAINT
  247.      TCUBEROUNDED
  248.      TEXTERNALENTITY
  249.      TSKINENTITY
  250.      TSKINENTITYNEW
  251.      TTRIANGLE
  252.      TSMOOTHTRIANGLE
  253.      TBLENDINGSHADER
  254.      TEXTERNALSHADER
  255.      TENVIRONMENT
  256.      TSHADERENVIRONMENT
  257.  
  258.  
  259.                                                                              4
  260.  
  261.  
  262.  
  263. Import-StudioPro()         Unix Programmer's Manual         Import-StudioPro()
  264.  
  265.  
  266.      TEXTERNALENVIRONMENT
  267.      THORIZONENVIRONMENT
  268.      TPICTUREENVIRONMENT
  269.      TRGBENVIRONMENT
  270.      TLAYER
  271.      TLINKAGES
  272.      T2DENTITY
  273.      T2DBEZIERCURVE
  274.      T2DBEZIERHOLE
  275.      T2DBEZIERREGION
  276.      TCLOSEDRIB
  277.      TOPENRIB
  278.      T2DGROUP
  279.      T2DOVAL
  280.      T2DROUNDRECT
  281.      TQUICKDISPLAYLIST
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                              5
  325.  
  326.